Skip to content

Conversation

@szegedi
Copy link

@szegedi szegedi commented Jan 15, 2026

What does this PR do?:

  • Discards the CPED approach where we replace the AsyncContextFrame (ACF) object in the CPED with a proxy that has an internal field for our sample context.
  • Instead, adopts an approach where the sample context is stored directly in the ACF map under an arbitrary key.
  • It is possible to pass in a key externally. Passing in an AsyncLocalStorage as the key will allow the sampling context object to be retrieved from JavaScript using storage.getStore() on that object. This opens the possibility of implementing custom contexts in dd-trace-js.
  • Also adds a createContextHolder method for direct use of custom contexts with AsyncLocalStorage.run()

Motivation:
Simplification, performance, and additional capabilities.
Simplification: Storing the sampling context directly in the ACF reduces the runtime complexity by not having a proxy object. Arguably, there's the added complexity of having the raw memory map reading code, but there's only so much complexity you can reduce and the remaining inherent complexity you can only push around from one place to another.
Performance: We also no longer need to ensure that the proxy object is updated every time a new async context is created, thus dd-trace-js no longer needs to instrument AsyncLocalStorage.enterWith, eliminating the need to do any JS work in any callback on context creation or switches. I think this is pretty significant. See https://github.com/DataDog/dd-trace-js/tree/szegedi/acf-simple for the dd-trace-js side of changes.
Additional capabilities: with the addition of createContextHolder it will be possible to implement an API like profiler.runWithCustomLabels(labels, fn) in dd-trace-js.

Additional Notes:
While storing the sampling context is now simpler, retrieving it from the signal handler actually got more complex, but that's a tradeoff we should make. Namely, in the signal handler now we need to chase pointers from current isolate to the hash table backing the ACF storage, and then also implement the hash table lookup-by-key. None of these data structures are published by V8, but we're defining equivalent ones that hold for the currently used V8 versions. They would also need to be updated if V8 internally changes them, but we have enough tests to detect if they no longer work.

For review, let me note that the first 5 commits are reverts of all the commits for the previous approach, so they just establish a clean slate on which to build the new approach. Few of the commits are just tests, or fixes for small things, or adjustments to make the big ones easier.
The consequential changes are all in these 4 commits:

If needed, I could probably pull this apart into several smaller PRs, let me know. The last two could even be separated into their own PRs as they're additional functionality.

How to test the change?
All existing CPED tests pass, and I've added some additional tests in test-get-value-from-map-profiler.ts. Funnily enough, for these tests I was creating profiler instances, but not starting them, which exposed (through ASAN, bless its name) some asymmetry in construction and destruction of WallProfiler that's not normally problematic (as normally time-profiler.ts always starts a created instance) but I fixed them anyway (specifically, registration of GC callbacks got moved from constructor to StartImpl and detachment and destruction of live context pointers got moved from Dispose to the actual ~WallProfiler.

@github-actions
Copy link

github-actions bot commented Jan 15, 2026

Overall package size

Self size: 1.81 MB
Deduped: 2.19 MB
No deduping: 2.19 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | source-map | 0.7.6 | 185.63 kB | 185.63 kB | | pprof-format | 2.2.1 | 163.06 kB | 163.06 kB | | p-limit | 3.1.0 | 7.75 kB | 13.78 kB | | delay | 5.0.0 | 11.17 kB | 11.17 kB | | node-gyp-build | 3.9.0 | 8.81 kB | 8.81 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

@szegedi szegedi force-pushed the szegedi/acf-simple branch from bb7b1ea to 11f315e Compare January 19, 2026 15:01
@pr-commenter
Copy link

pr-commenter bot commented Jan 19, 2026

Benchmarks

Benchmark execution time: 2026-02-09 11:26:51

Comparing candidate commit ba3946e in PR branch szegedi/acf-simple with baseline commit eb9eabd in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 92 metrics, 28 unstable metrics.

@szegedi szegedi force-pushed the szegedi/acf-simple branch 5 times, most recently from 067ef72 to a425da6 Compare January 27, 2026 14:11
@szegedi szegedi added the semver-minor Usually minor non-breaking improvements label Jan 27, 2026
@szegedi szegedi force-pushed the szegedi/acf-simple branch 4 times, most recently from 30c38cb to 9f0aa90 Compare January 27, 2026 17:01
@szegedi szegedi marked this pull request as ready for review January 27, 2026 17:12
…heir deregistration through StopImpl->Dispose.

This was usually not a problem but test-get-value-from-map-profiler.ts creates a profiler without starting it.
This was usually not a problem but test-get-value-from-map-profiler.ts creates a profiler without starting it.
@nsavoire
Copy link

nsavoire commented Feb 9, 2026

@codex review

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 053743d871

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +1192 to +1197
Local<Object> WallProfiler::CreateContextHolder(Isolate* isolate,
Local<Context> v8Ctx,
Local<Value> value) {
auto wrap =
wrapObjectTemplate_.Get(isolate)->NewInstance(v8Ctx).ToLocalChecked();
// for easy access from JS when cpedKey is an ALS, it can do

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Guard createContextHolder when CPED is disabled

The new CreateContextHolder method unconditionally dereferences wrapObjectTemplate_ and calls ToLocalChecked(), but that template is only initialized when useCPED is true in the constructor (see the if (useCPED) block around lines 660–669). If a user creates a TimeProfiler with the default useCPED: false (or on a platform where CPED is unavailable) and calls createContextHolder(), this will hit an empty Persistent and trigger a V8 fatal error instead of a clean exception. Consider checking useCPED()/wrapObjectTemplate_.IsEmpty() and throwing a JS error similar to runWithContext to avoid a hard crash.

Useful? React with 👍 / 👎.

@szegedi szegedi force-pushed the szegedi/acf-simple branch from cd4b96a to ba3946e Compare February 9, 2026 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver-minor Usually minor non-breaking improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants